/* 
 * Copyright 2013 Sébastien Mouquet.
 * 
 * This file is part of ECovoiturage.
 * 
 * ECovoiturage is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * ECovoiturage is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with ECovoiturage. If not, see http://www.gnu.org/licenses/.
 */
package com.smouquet.ecovoiturage.core.service;

import com.smouquet.ecovoiturage.core.bean.TrajetMidiItem;
import com.smouquet.ecovoiturage.core.domain.Trajet;
import java.util.Date;
import java.util.List;

/**
 * Service concernant l'entité {@link Trajet}.
 * 
 * @author sebastien.mouquet
 */
public interface TrajetService
{
    /**
     * Retourne tous les trajets du midi pour une date données.
     * Si la date est <code>null</code>, ce sont les trajets du
     * jour qui sont renvoyés.
     * 
     * @param jour Date des trajets à retournée (Optionnel, par défaut la date du jour)
     * @return Liste des trajets du midi pour une date donnée.
     */
    List<TrajetMidiItem> getAllTrajetsMidiByJour(Date jour);
    
    /**
     * Retourne un trajet par rapport à son identifiant.
     * 
     * @param idTrajet Identifiant du trajet (non null)
     * @return Le trajet correspondant
     * @throws IllegalArgumentException Si idTrajet est null
     */
    Trajet getById(Integer idTrajet);
    
    /**
     * Ajoute le trajet en base de données.
     * 
     * @param trajet Trajet à ajouter (non null)
     * @throws IllegalArgumentException Si trajet est null
     * @return Retourne le trajet ajouté
     */
    Trajet addTrajet(Trajet trajet);
    
    /**
     * Met à jour le trajet transmit en base de données.
     * 
     * @param trajet Trajet à mettre à jour (non null)
     * @throws IllegalArgumentException Si trajet est null
     * @return Retourne le trajet mis à jour
     */
    Trajet updateTrajet(Trajet trajet);
}
